Skip to content

fix: make Docker Compose and Docker Run sections self-contained - #256

Closed
manato-tajiri wants to merge 1 commit into
gamosoft:mainfrom
manato-tajiri:fix/self-contained-docker-setup
Closed

fix: make Docker Compose and Docker Run sections self-contained#256
manato-tajiri wants to merge 1 commit into
gamosoft:mainfrom
manato-tajiri:fix/self-contained-docker-setup

Conversation

@manato-tajiri

Copy link
Copy Markdown

Problem

The Docker Compose and Docker Run sections in the README were not self-contained. Users jumping directly to these sections would run without existing, causing Docker to create it as a directory (Docker's behavior when binding a non-existent file path to a container).

Fix

Each Docker section now includes all prerequisite commands inline:

  • Option 1 (Docker Compose): Added , for , , before the compose commands. Added PowerShell code block for Windows users.
  • Option 2 (Docker Run): Added , for , , before the command. Added PowerShell code block for Windows users.

Each section is now a complete copy-paste solution that works without referencing other sections.

Fixes the issue where was created as a directory by Docker when users jumped directly to the Docker Compose section without completing prerequisite setup steps.

- Add mkdir, curl/Invoke-WebRequest commands inline in both Docker sections
- Add PowerShell code blocks for Windows users
- Each section is now a complete copy-paste solution
- Fixes the issue where config.yaml was created as a directory by Docker
  when users jumped directly to the Docker Compose section without
  completing prerequisite setup steps
@gamosoft

Copy link
Copy Markdown
Owner

Hi @manato-tajiri, thanks for the PR and the write-up!

This should already be covered: the current docker-compose.*.yml no longer bind-mounts config.yaml /themes/ /plugins/ /locales/ by default (they're commented out with a # file/folder must exist with content! note), and the Advanced Docker Setup section in the README calls out the "file/folder must exist with valid content" rule for anyone opting into customization.

And as @pejotigrek noted, this is really just Docker's standard bind-mount behavior, not something specific to NoteDiscovery. Going to close this out, but thanks again! 🙏

@gamosoft gamosoft closed this Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants